/***********************************************************************************************************************
*                                                                                                                      *
* SPLASH build system v0.1                                                                                             *
*                                                                                                                      *
* Copyright (c) 2013 Andrew D. Zonenberg                                                                               *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the       *
*      following disclaimer in the documentation and/or other materials provided with the distribution.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   *
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES        *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR       *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE       *
* POSSIBILITY OF SUCH DAMAGE.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/

#ifndef Cluster_h
#define Cluster_h

/**
	@brief A single job on a cluster
 */
class ClusterJob
{
public:
	virtual ~ClusterJob();

	enum JobStatus
	{
		JOB_STATE_PENDING,		//Job is in the queue but hasn't started yet
		JOB_STATE_RUNNING,		//Job is currently running
		JOB_STATE_COMPLETE,		//Job completed OK
		JOB_STATE_FAILED,		//Job did not complete successfully (bad exit code)
		JOB_STATE_CANCELED,		//Job did not complete successfully (canceled before finishing)
	};
	
	virtual JobStatus GetStatus() =0;
	
	virtual void Cancel() =0;
	
	virtual std::string GetID() =0;
};

/**
	@brief A placeholder for a failed operation
 */
class FailedClusterJob : public ClusterJob
{
public:
	virtual JobStatus GetStatus()
	{ return JOB_STATE_FAILED; }
	
	///@brief already failed, no need to cancel
	virtual void Cancel()
	{ }
	
	virtual std::string GetID()
	{ return "failed"; }
};

/**
	@brief Interface to a cluster scheduling system
 */
class Cluster
{
public:
	virtual ~Cluster();

	/**
		@brief Submits a batch job to the cluster.
		
		@param path				Full path to the batch script.
		@param partition		Partition name
		@param dir				Working directory
		@param dependencies		Vector of jobs which must complete successfully for this job to run.
								If any job in the dependency list fails, this job will be canceled.
		@param cpus				CPUs per task (only one task submitted in this implementation)
		@param memory			RAM to be reserved for this task (in MB)
		@param features			Additional node attributes required
	 */
	virtual ClusterJob* SubmitBatchJob(std::string path, std::string partition, std::string dir, const std::vector<ClusterJob*>& dependencies, int cpus=1, int memory=512, std::string features="") =0;
	
	static Cluster* CreateDefaultCluster();
	
	///@brief The name of the partition to which C++ build jobs should be submitted
	std::string m_cppBuildPartition;
	
	///@brief The name of the partition to which FPGA build jobs should be submitted
	std::string m_fpgaBuildPartition;
};

#endif
